Skip to content

PoC for device flag clarity#2039

Draft
ekcoh wants to merge 2 commits intodevelopfrom
isx-2177-device-flag-clarity
Draft

PoC for device flag clarity#2039
ekcoh wants to merge 2 commits intodevelopfrom
isx-2177-device-flag-clarity

Conversation

@ekcoh
Copy link
Collaborator

@ekcoh ekcoh commented Oct 28, 2024 •
edited
Loading

Description

Please fill this section with a description what the pull request is trying to address and what changes were made.

TODO Convert list into foldout to not steal screen space

Testing status & QA

Please describe the testing already done by you and what testing you request/recommend QA to execute. If you used or created any testing project please link them here too for QA.

Overall Product Risks

Please rate the potential complexity and halo effect from low to high for the reviewers. Note down potential risks to specific Editor branches if any.

  • Complexity:
  • Halo Effect:

Comments to reviewers

Please describe any additional information such as what to focus on, or historical info for the reviewers.

Checklist

Before review:

  • Changelog entry added.
    • Explains the change in Changed, Fixed, Added sections.
    • For API change contains an example snippet and/or migration example.
    • JIRA ticket linked, example (case %%). If it is a private issue, just add the case ID without a link.
    • Jira port for the next release set as "Resolved".
  • Tests added/changed, if applicable.
    • Functional tests Area_CanDoX, Area_CanDoX_EvenIfYIsTheCase, Area_WhenIDoX_AndYHappens_ThisIsTheResult.
    • Performance tests.
    • Integration tests.
  • Docs for new/changed API's.
    • Xmldoc cross references are set correctly.
    • Added explanation how the API works.
    • Usage code examples added.
    • The manual is updated, if needed.

During merge:

  • Commit message for squash-merge is prefixed with one of the list:
    • NEW: ___.
    • FIX: ___.
    • DOCS: ___.
    • CHANGE: ___.
    • RELEASE: 1.1.0-preview.3.

After merge:

  • Create forward/backward port if needed. If you are blocked from creating a forward port now please add a task to ISX-1444.

@ekcoh ekcoh added the work in progress Indicates that the PR is work in progress and any review efforts can be post-poned. label Oct 28, 2024
@ekcoh
Copy link
Collaborator Author

ekcoh commented Nov 6, 2024

After having this PR marinating for a while I would suggest next step is to abandon the suggested UI change and instead move flags into the Device hierarchy in the main device overview of the Input Debugger. This way, the top box, which currently suffers from IMGUI resizing difficulties would not steal precious screen space from the other 2 live logging perspectives it shares the window with.

@jfreire-unity jfreire-unity requested a review from Copilot April 8, 2025 11:09
Copilot AI reviewed Apr 8, 2025
View reviewed changes
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot reviewed 2 out of 3 changed files in this pull request and generated 2 comments.

Files not reviewed (1)
  • Packages/com.unity.inputsystem/InputSystem/Editor/Internal/DeviceFlagsTreeView.cs.meta: Language not supported

Packages/com.unity.inputsystem/InputSystem/Editor/Internal/DeviceFlagsTreeView.cs
{
root.AddChild(new FlagItem()
{
id = 1,
Copy link

Copilot AI Apr 8, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Each FlagItem is assigned the same id, which may result in duplicate IDs in the tree view. Consider generating unique ids for each flag, for example by hashing the flag value or using an incremental counter.

Suggested change
id = 1,
id = m_NextId++,

Copilot uses AI. Check for mistakes.
Packages/com.unity.inputsystem/InputSystem/Editor/Debugger/InputDeviceDebuggerWindow.cs
EditorGUILayout.LabelField("HasEventPreProcessor", m_Device.hasEventPreProcessor ? kTrue : kFalse);
EditorGUILayout.LabelField("DisabledInFrontend", m_Device.disabledInFrontend ? kTrue : kFalse);
EditorGUILayout.LabelField("DisabledInRuntime", m_Device.disabledInRuntime ? kTrue : kFalse);
EditorGUILayout.LabelField("DisabledWWhileInBackground", m_Device.disabledWhileInBackground ? kTrue : kFalse);
Copy link

Copilot AI Apr 8, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[nitpick] Typo found in the label text "DisabledWWhileInBackground". It should likely be corrected to "DisabledWhileInBackground".

Suggested change
EditorGUILayout.LabelField("DisabledWWhileInBackground", m_Device.disabledWhileInBackground ? kTrue : kFalse);
EditorGUILayout.LabelField("DisabledWhileInBackground", m_Device.disabledWhileInBackground ? kTrue : kFalse);

Copilot uses AI. Check for mistakes.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

Copilot code review Copilot Copilot left review comments

At least 1 approving review is required to merge this pull request.

Assignees

No one assigned

Labels

work in progress Indicates that the PR is work in progress and any review efforts can be post-poned.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

1 participant

@ekcoh